micromark-util-symbol

micromark-util-symbol

micromark utility with symbols.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
• Types
• Compatibility
• Security
• Contribute
• License

What is this?

This package exposes constants used throughout the micromark ecosystem.

When should I use this?

This package is useful when you are making your own micromark extensions. It’s useful to reference these constants by name instead of value while developing. micromark-build compiles them away for production code.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install micromark-util-symbol

In Deno with esm.sh:

import {codes} from 'https://esm.sh/micromark-util-symbol/codes@1'

In browsers with esm.sh:

<script type="module">
  import {codes} from 'https://esm.sh/micromark-util-symbol/codes@1?bundle'
</script>

Use

import {codes} from 'micromark-util-symbol/codes'
import {constants} from 'micromark-util-symbol/constants'
import {types} from 'micromark-util-symbol/types'
import {values} from 'micromark-util-symbol/values'

console.log(codes.atSign) // 64
console.log(constants.characterReferenceNamedSizeMax) // 31
console.log(types.definitionDestinationRaw) // 'definitionDestinationRaw'
console.log(values.atSign) // '@'

API

This package has four entries in its export map: micromark-util-symbol/codes, micromark-util-symbol/constants, micromark-util-symbol/types, micromark-util-symbol/values.

Each module exports an identifier with the same name (for example, micromark-util-symbol/codes has codes), which is an object mapping strings to other values.

See the code for the exposed data.

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 16+. Our projects sometimes work with older versions, but this is not guaranteed.

This package works with micromark version 3+.

Security

This package is safe. See security.md in micromark/.github for how to submit a security report.

Contribute

See contributing.md in micromark/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer